fix overlong inline literal by adding space, remove triple backtick, replace hyphens with en-dashes#622
Conversation
If an inline literal like "``foo``" is too long to fit on screen, and it doesn't contain spaces, it won't include line-breaks, and for example on mobile this will extend past the right edge of the screen, allowing horizontal scrolling which is not wanted on mobile. Hence adding more spaces allows for more chances to break the literal, decreasing the chance this happens.
There was a problem hiding this comment.
Pull request overview
Improves Sphinx/reStructuredText tutorial readability by ensuring inline literals don’t cause horizontal overflow (especially on mobile) and by using correct inline-literal markup.
Changes:
- Replaced Markdown-style triple backticks with reST inline literals (double backticks) for an inline method call.
- Added a missing space after a comma in an inline
get_davclient(...)example to improve wrapping opportunities.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
joshinils
changed the title
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 1 out of 1 changed files in this pull request and generated 7 comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
joshinils
changed the title
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
|
I hope to get time to look into this a bit later today. Pull requests improving the quality of the documentation is in general mostly welcome, but I'll be AFK over the next few hours :-) |
Co-authored-by: joshinils <34302971+joshinils@users.noreply.github.com>
|
Oh. I'm sorry to say that the tutorial you were editing was already an old version of it. The newest version is on the v3.0-dev branch. I will try to resolve the conflicts there, but it may seem like all the stuff you were fixing was already fixed or removed in the v3.0-dev branch. |
2 participants
If an inline literal like "``foo``" is too long to fit on screen, and it doesn't contain spaces, it won't include line-breaks, and for example on mobile this will extend past the right edge of the screen, allowing horizontal scrolling which is not wanted on mobile.
Hence adding more spaces allows for more chances to break the literal, decreasing the chance this happens.